Skip to content

Fix id parameter in Agent Builder tool APIs #243099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Nov 20, 2025
Merged

Fix id parameter in Agent Builder tool APIs #243099

merged 6 commits into from
Nov 20, 2025
+34 −40

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 14, 2025 •
edited by kibanamachine
Loading

Summary

This PR addresses the following error that's returned by make api-docs-lint:

  2818:3     error    no-identical-paths              The path already exists which differs only by path parameter name(s): `/api/agent_builder/tools/{id}` and `/api/agent_builder/tools/{toolId}`.

Some of the APIs in tools.ts were using a parameter variable named tooldId (e.g. https://www.elastic.co/docs/api/doc/kibana/operation/operation-put-agent-builder-tools-toolid) while others were using id (e.g. https://www.elastic.co/docs/api/doc/kibana/operation/operation-delete-agent-builder-tools-id), so I updated them to all use toolId.

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

- [ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
- [ ] Documentation was added for features that require explanation or tutorials
- [ ] Unit or functional tests were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
- [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
- [ ] Flaky Test Runner was used on any tests changed
- [ ] The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines
- [ ] Review the backport guidelines and apply applicable backport:* labels.

Identify risks

N/A

@lcawl lcawl added docs Team:Docs release_note:skip Skip the PR/issue when compiling release notes v9.3.0 v9.2.2 backport:version Backport to applied version labels labels Nov 14, 2025
@lcawl lcawl marked this pull request as ready for review November 14, 2025 22:23
@lcawl lcawl requested review from a team as code owners November 14, 2025 22:23
@elasticmachine
Copy link
Contributor

elasticmachine commented Nov 14, 2025

Pinging @elastic/experience-docs (Team:Docs)

florent-leborgne
florent-leborgne approved these changes Nov 20, 2025
View reviewed changes
Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@elasticmachine
Copy link
Contributor

elasticmachine commented Nov 20, 2025 •
edited
Loading

💔 Build Failed

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #129 / Search Profiler Profile should return profile results for a valid index
  • [job] [logs] FTR Configs #90 / Serverless Observability feature flag testing - Deployment-agnostic Observability Agent API integration tests Observability Agent tool: observability.get_anomaly_detection_jobs "after all" hook for "returns job without anomalies when time range excludes them"
  • [job] [logs] FTR Configs #90 / Serverless Observability feature flag testing - Deployment-agnostic Observability Agent API integration tests Observability Agent tool: observability.get_anomaly_detection_jobs "after all" hook for "returns job without anomalies when time range excludes them"
  • [job] [logs] FTR Configs #90 / Serverless Observability feature flag testing - Deployment-agnostic Observability Agent API integration tests Observability Agent tool: observability.get_anomaly_detection_jobs "before all" hook for "filters by specific job ID"
  • [job] [logs] FTR Configs #90 / Serverless Observability feature flag testing - Deployment-agnostic Observability Agent API integration tests Observability Agent tool: observability.get_anomaly_detection_jobs "before all" hook for "filters by specific job ID"

Metrics [docs]

✅ unchanged

History

@lcawl lcawl enabled auto-merge (squash) November 20, 2025 17:07
@lcawl lcawl merged commit 278bb4e into elastic:main Nov 20, 2025
12 checks passed
@kibanamachine
Copy link
Contributor

kibanamachine commented Nov 20, 2025

Starting backport for target branches: 9.2

https://github.com/elastic/kibana/actions/runs/19548474796

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Nov 20, 2025
@lcawl
Fix id parameter in Agent Builder tool APIs (elastic#243099)
43514c1 
(cherry picked from commit 278bb4e)
@kibanamachine kibanamachine mentioned this pull request Nov 20, 2025
Merged
@kibanamachine
Copy link
Contributor

kibanamachine commented Nov 20, 2025

💚 All backports created successfully

Status Branch Result
✅ 9.2

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl deleted the tools-api-fix branch November 20, 2025 19:44
kibanamachine added a commit that referenced this pull request Nov 20, 2025
@kibanamachine @lcawl
[9.2] Fix id parameter in Agent Builder tool APIs (#243099) (#243717)
25eebfc 
# Backport

This will backport the following commits from `main` to `9.2`:
- [Fix id parameter in Agent Builder tool APIs
(#243099)](#243099)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-11-20T19:11:03Z","message":"Fix
id parameter in Agent Builder tool APIs
(#243099)","sha":"278bb4ea35e25947a21f3f0e83370bc5760f5699","branchLabelMapping":{"^v9.3.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:version","v9.3.0","v9.2.2"],"title":"Fix
id parameter in Agent Builder tool
APIs","number":243099,"url":"https://github.com/elastic/kibana/pull/243099","mergeCommit":{"message":"Fix
id parameter in Agent Builder tool APIs
(#243099)","sha":"278bb4ea35e25947a21f3f0e83370bc5760f5699"}},"sourceBranch":"main","suggestedTargetBranches":["9.2"],"targetPullRequestStates":[{"branch":"main","label":"v9.3.0","branchLabelMappingKey":"^v9.3.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/243099","number":243099,"mergeCommit":{"message":"Fix
id parameter in Agent Builder tool APIs
(#243099)","sha":"278bb4ea35e25947a21f3f0e83370bc5760f5699"}},{"branch":"9.2","label":"v9.2.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pgayvallet pgayvallet pgayvallet approved these changes

@florent-leborgne florent-leborgne florent-leborgne approved these changes

Assignees

No one assigned

Labels

backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v9.2.2 v9.3.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@lcawl @elasticmachine @kibanamachine @pgayvallet @florent-leborgne